home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / COPYSUPPORT.PY < prev    next >
Encoding:
Python Source  |  2000-08-21  |  20.0 KB  |  549 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. __doc__="""Copy interface"""
  86. __version__='$Revision: 1.55.8.2 $'[11:-2]
  87.  
  88. import sys, string, Globals, Moniker, tempfile, ExtensionClass
  89. from marshal import loads, dumps
  90. from urllib import quote, unquote
  91. from zlib import compress, decompress
  92. from App.Dialogs import MessageDialog
  93. from AccessControl import getSecurityManager
  94.  
  95.  
  96. CopyError='Copy Error'
  97.  
  98. _marker=[]
  99. class CopyContainer(ExtensionClass.Base):
  100.     """Interface for containerish objects which allow cut/copy/paste"""
  101.  
  102.     __ac_permissions__=(
  103.         ('View management screens',
  104.          ('manage_cutObjects', 'manage_copyObjects', 'manage_pasteObjects',
  105.           'manage_renameForm', 'manage_renameObject', 'manage_renameObjects',)),
  106.         )
  107.  
  108.  
  109.     # The following three methods should be overridden to store sub-objects
  110.     # as non-attributes.
  111.     def _setOb(self, id, object): setattr(self, id, object)
  112.     def _delOb(self, id): delattr(self, id)
  113.     def _getOb(self, id, default=_marker):
  114.         if hasattr(self, 'aq_base'): self=self.aq_base
  115.         if default is _marker: return getattr(self, id)
  116.         try: return getattr(self, id)
  117.         except: return default
  118.  
  119.  
  120.     def manage_CopyContainerFirstItem(self, REQUEST):
  121.         return self._getOb(REQUEST['ids'][0])
  122.  
  123.     def manage_CopyContainerAllItems(self, REQUEST):
  124.         return map(lambda i, s=self: s._getOb(i), tuple(REQUEST['ids']))
  125.  
  126.     def manage_cutObjects(self, ids, REQUEST=None):
  127.         """Put a reference to the objects named in ids in the clip board"""
  128.         if type(ids) is type(''):
  129.             ids=[ids]
  130.         oblist=[]
  131.         for id in ids:
  132.             ob=self._getOb(id)
  133.             if not ob.cb_isMoveable():
  134.                 raise CopyError, eNotSupported % id
  135.             m=Moniker.Moniker(ob)
  136.             oblist.append(m.dump())
  137.         cp=(1, oblist)
  138.         cp=_cb_encode(cp)
  139.         if REQUEST is not None:
  140.             resp=REQUEST['RESPONSE']
  141.             resp.setCookie('__cp', cp, path='%s' % REQUEST['SCRIPT_NAME'])
  142.             return self.manage_main(self, REQUEST, cb_dataValid=1)
  143.         return cp
  144.     
  145.     def manage_copyObjects(self, ids, REQUEST=None, RESPONSE=None):
  146.         """Put a reference to the objects named in ids in the clip board"""
  147.         if type(ids) is type(''):
  148.             ids=[ids]
  149.         oblist=[]
  150.         for id in ids:
  151.             ob=self._getOb(id)
  152.             if not ob.cb_isCopyable():
  153.                 raise CopyError, eNotSupported % id
  154.             m=Moniker.Moniker(ob)
  155.             oblist.append(m.dump())
  156.         cp=(0, oblist)
  157.         cp=_cb_encode(cp)
  158.         if REQUEST is not None:
  159.             resp=REQUEST['RESPONSE']
  160.             resp.setCookie('__cp', cp, path='%s' % REQUEST['SCRIPT_NAME'])
  161.             return self.manage_main(self, REQUEST, cb_dataValid=1)
  162.         return cp
  163.  
  164.     def _get_id(self, id):
  165.         # Allow containers to override the generation of
  166.         # object copy id by attempting to call its _get_id
  167.         # method, if it exists.
  168.         n=0
  169.         if (len(id) > 8) and (id[8:]=='copy_of_'):
  170.             n=1
  171.         orig_id=id
  172.         while 1:
  173.             if self._getOb(id, None) is None:
  174.                 return id
  175.             id='copy%s_of_%s' % (n and n+1 or '', orig_id)
  176.             n=n+1
  177.  
  178.     def manage_pasteObjects(self, cb_copy_data=None, REQUEST=None):
  179.         """Paste previously copied objects into the current object.
  180.            If calling manage_pasteObjects from python code, pass
  181.            the result of a previous call to manage_cutObjects or
  182.            manage_copyObjects as the first argument."""
  183.         cp=None
  184.         if cb_copy_data is not None:
  185.             cp=cb_copy_data
  186.         else:
  187.             if REQUEST and REQUEST.has_key('__cp'):
  188.                 cp=REQUEST['__cp']
  189.         if cp is None:
  190.             raise CopyError, eNoData
  191.         
  192.         try:    cp=_cb_decode(cp)
  193.         except: raise CopyError, eInvalid
  194.  
  195.         oblist=[]
  196.         op=cp[0]
  197.         app = self.getPhysicalRoot()
  198.  
  199.         for mdata in cp[1]:
  200.             m = Moniker.loadMoniker(mdata)
  201.             try: ob = m.bind(app)
  202.             except: raise CopyError, eNotFound
  203.             self._verifyObjectPaste(ob)
  204.             oblist.append(ob)
  205.  
  206.         if op==0:
  207.             # Copy operation
  208.             for ob in oblist:
  209.                 if not ob.cb_isCopyable():
  210.                     raise CopyError, eNotSupported % absattr(ob.id)
  211.                 try:    ob._notifyOfCopyTo(self, op=0)
  212.                 except: raise CopyError, MessageDialog(
  213.                     title='Copy Error',
  214.                     message=sys.exc_info()[1],
  215.                     action ='manage_main')
  216.                 ob=ob._getCopy(self)
  217.                 ob.manage_afterClone(ob)
  218.                 id=self._get_id(absattr(ob.id))
  219.                 ob._setId(id)
  220.                 self._setObject(id, ob)
  221.  
  222.             if REQUEST is not None:
  223.                 return self.manage_main(self, REQUEST, update_menu=1,
  224.                                         cb_dataValid=1)
  225.  
  226.         if op==1:
  227.             # Move operation
  228.             for ob in oblist:
  229.                 id=absattr(ob.id)
  230.                 if not ob.cb_isMoveable():
  231.                     raise CopyError, eNotSupported % id
  232.                 try:    ob._notifyOfCopyTo(self, op=1)
  233.                 except: raise CopyError, MessageDialog(
  234.                     title='Move Error',
  235.                     message=sys.exc_info()[1],
  236.                     action ='manage_main')
  237.                 if not sanity_check(self, ob):
  238.                     raise CopyError, 'This object cannot be pasted into itself'
  239.  
  240.                 # try to make ownership explicit so that it gets carried
  241.                 # along to the new location if needed.
  242.                 ob.manage_changeOwnershipType(explicit=1)
  243.                 
  244.                 ob.aq_parent._delObject(id)
  245.                 if hasattr(ob, 'aq_base'):
  246.                     ob=ob.aq_base
  247.                 id=self._get_id(id)
  248.                 ob._setId(id)
  249.  
  250.                 self._setObject(id, ob, set_owner=0)
  251.  
  252.                 # try to make ownership implicit if possible
  253.                 ob=self._getOb(id)
  254.                 ob.manage_changeOwnershipType(explicit=0)
  255.  
  256.             if REQUEST is not None:
  257.                 REQUEST['RESPONSE'].setCookie('cp_', 'deleted',
  258.                                     path='%s' % REQUEST['SCRIPT_NAME'],
  259.                                     expires='Wed, 31-Dec-97 23:59:59 GMT')
  260.                 return self.manage_main(self, REQUEST, update_menu=1,
  261.                                         cb_dataValid=0)
  262.         return ''
  263.  
  264.  
  265.     manage_renameForm=Globals.HTMLFile('renameForm', globals())
  266.  
  267.     def manage_renameObjects(self, ids, new_ids, REQUEST=None):
  268.         """Rename several sub-objects"""
  269.         if len(ids) != len(new_ids):
  270.             raise 'BadRequst','Please rename each listed object.'
  271.         for i in range(len(ids)):
  272.             if ids[i] != new_ids[i]:
  273.                 self.manage_renameObject(ids[i], new_ids[i], REQUEST)
  274.         if REQUEST is not None:
  275.             return self.manage_main(self, REQUEST, update_menu=1)
  276.         return None
  277.  
  278.     def manage_renameObject(self, id, new_id, REQUEST=None):
  279.         """Rename a particular sub-object"""
  280.         try: self._checkId(new_id)
  281.         except: raise CopyError, MessageDialog(
  282.                       title='Invalid Id',
  283.                       message=sys.exc_info()[1],
  284.                       action ='manage_main')
  285.         ob=self._getOb(id)
  286.         if not ob.cb_isMoveable():
  287.             raise CopyError, eNotSupported % id            
  288.         self._verifyObjectPaste(ob)
  289.         try:    ob._notifyOfCopyTo(self, op=1)
  290.         except: raise CopyError, MessageDialog(
  291.                       title='Rename Error',
  292.                       message=sys.exc_info()[1],
  293.                       action ='manage_main')
  294.         self._delObject(id)
  295.         if hasattr(ob, 'aq_base'):
  296.             ob=ob.aq_base
  297.         ob._setId(new_id)
  298.         
  299.         # Note - because a rename always keeps the same context, we
  300.         # can just leave the ownership info unchanged.
  301.         self._setObject(new_id, ob, set_owner=0)
  302.  
  303.         if REQUEST is not None:
  304.             return self.manage_main(self, REQUEST, update_menu=1)
  305.         return None
  306.  
  307.     # Why did we give this a manage_ prefix if its really
  308.     # supposed to be public since it does its own auth ?
  309.     #
  310.     # Because it's still a "management" function.
  311.     manage_clone__roles__=None
  312.     def manage_clone(self, ob, id, REQUEST=None):
  313.         # Clone an object, creating a new object with the given id.
  314.         if not ob.cb_isCopyable():
  315.             raise CopyError, eNotSupported % absattr(ob.id)            
  316.         try: self._checkId(id)
  317.         except: raise CopyError, MessageDialog(
  318.                       title='Invalid Id',
  319.                       message=sys.exc_info()[1],
  320.                       action ='manage_main')
  321.         self._verifyObjectPaste(ob)
  322.         try:    ob._notifyOfCopyTo(self, op=0)
  323.         except: raise CopyError, MessageDialog(
  324.                       title='Clone Error',
  325.                       message=sys.exc_info()[1],
  326.                       action ='manage_main')
  327.         ob=ob._getCopy(self)
  328.         ob._setId(id)
  329.         self._setObject(id, ob)
  330.         ob=ob.__of__(self)
  331.         #ob._postCopy(self, op=0)
  332.         return ob
  333.  
  334.     def cb_dataValid(self):
  335.         # Return true if clipboard data seems valid.
  336.         try:    cp=_cb_decode(self.REQUEST['__cp'])
  337.         except: return 0
  338.         return 1
  339.  
  340.     def cb_dataItems(self):
  341.         # List of objects in the clip board
  342.         try:    cp=_cb_decode(self.REQUEST['__cp'])
  343.         except: return []
  344.         oblist=[]
  345.  
  346.         app = self.getPhysicalRoot()
  347.         for mdata in cp[1]:
  348.             m = Moniker.loadMoniker(mdata)
  349.             oblist.append(m.bind(app))
  350.         return oblist
  351.  
  352.     validClipData=cb_dataValid
  353.  
  354.     def _verifyObjectPaste(self, object, validate_src=1):
  355.         # Verify whether the current user is allowed to paste the
  356.         # passed object into self. This is determined by checking
  357.         # to see if the user could create a new object of the same
  358.         # meta_type of the object passed in and checking that the
  359.         # user actually is allowed to access the passed in object
  360.         # in its existing context.
  361.         #
  362.         # Passing a false value for the validate_src argument will skip
  363.         # checking the passed in object in its existing context. This is
  364.         # mainly useful for situations where the passed in object has no 
  365.         # existing context, such as checking an object during an import
  366.         # (the object will not yet have been connected to the acquisition
  367.         # heirarchy).
  368.         if not hasattr(object, 'meta_type'):
  369.             raise CopyError, MessageDialog(
  370.                   title='Not Supported',
  371.                   message='The object <EM>%s</EM> does not support this ' \
  372.                           'operation' % absattr(object.id),
  373.                   action='manage_main')
  374.         mt=object.meta_type
  375.         if not hasattr(self, 'all_meta_types'):
  376.             raise CopyError, MessageDialog(
  377.                   title='Not Supported',
  378.                   message='Cannot paste into this object.',
  379.                   action='manage_main')
  380.  
  381.         method_name=None
  382.         meta_types=absattr(self.all_meta_types)
  383.         for d in meta_types:
  384.             if d['name']==mt:
  385.                 method_name=d['action']
  386.                 break
  387.  
  388.         if method_name is not None:
  389.             meth=self.unrestrictedTraverse(method_name)
  390.             try:    parent=object.aq_inner.aq_parent
  391.             except: parent=None
  392.             if getSecurityManager().validate(None, parent, None, meth):
  393.                 # Ensure the user is allowed to access the object on the
  394.                 # clipboard.
  395.                 if not validate_src:
  396.                     return
  397.                 try:    parent=object.aq_inner.aq_parent
  398.                 except: parent=None
  399.                 if getSecurityManager().validate(None, parent, None, object):
  400.                     return
  401.  
  402.         raise CopyError, MessageDialog(
  403.               title='Not Supported',
  404.               message='The object <EM>%s</EM> does not support this ' \
  405.                       'operation' % absattr(object.id),
  406.               action='manage_main')
  407.  
  408. Globals.default__class_init__(CopyContainer)
  409.  
  410.  
  411.  
  412. class CopySource:
  413.     """Interface for objects which allow themselves to be copied."""
  414.     
  415.     def _canCopy(self, op=0):
  416.         """Called to make sure this object is copyable. The op var
  417.         is 0 for a copy, 1 for a move."""
  418.         return 1
  419.  
  420.     def _notifyOfCopyTo(self, container, op=0):
  421.         """Overide this to be pickly about where you go! If you dont
  422.         want to go there, raise an exception. The op variable is
  423.         0 for a copy, 1 for a move."""
  424.         pass
  425.  
  426.     def _getCopy(self, container):
  427.         # Ask an object for a new copy of itself.
  428.         f=tempfile.TemporaryFile()
  429.         self._p_jar.exportFile(self._p_oid,f)
  430.         f.seek(0)
  431.         ob=container._p_jar.importFile(f)
  432.         f.close()
  433.         return ob
  434.  
  435.     def _postCopy(self, container, op=0):
  436.         # Called after the copy is finished to accomodate special cases.
  437.         # The op var is 0 for a copy, 1 for a move.
  438.         pass
  439.     
  440.     def _setId(self, id):
  441.         # Called to set the new id of a copied object.
  442.         self.id=id
  443.  
  444.     def cb_isCopyable(self):
  445.         # Is object copyable? Returns 0 or 1
  446.         if not (hasattr(self, '_canCopy') and self._canCopy(0)):
  447.             return 0
  448.         if hasattr(self, '_p_jar') and self._p_jar is None:
  449.             return 0
  450.         return 1
  451.  
  452.     def cb_isMoveable(self):
  453.         # Is object moveable? Returns 0 or 1
  454.         if not (hasattr(self, '_canCopy') and self._canCopy(1)):
  455.             return 0
  456.         if hasattr(self, '_p_jar') and self._p_jar is None:
  457.             return 0
  458.         try:    n=self.aq_parent._reserved_names
  459.         except: n=()
  460.         if absattr(self.id) in n:
  461.             return 0
  462.         return 1
  463.  
  464.  
  465.  
  466. def sanity_check(c, ob):
  467.     # This is called on cut/paste operations to make sure that
  468.     # an object is not cut and pasted into itself or one of its
  469.     # subobjects, which is an undefined situation.
  470.     ob=getattr(ob, 'aq_base', ob)
  471.     while 1:
  472.         if getattr(c, 'aq_base', c) is ob:
  473.             return 0
  474.         if not hasattr(c, 'aq_parent'):
  475.             return 1
  476.         c=c.aq_parent
  477.  
  478. def absattr(attr):
  479.     if callable(attr): return attr()
  480.     return attr
  481.  
  482. def _cb_encode(d):
  483.     return quote(compress(dumps(d), 9))
  484.  
  485. def _cb_decode(s):
  486.     return loads(decompress(unquote(s)))
  487.  
  488.  
  489.  
  490.  
  491. fMessageDialog=Globals.HTML("""
  492. <HTML>
  493. <HEAD>
  494. <TITLE><dtml-var title></TITLE>
  495. </HEAD>
  496. <BODY BGCOLOR="#FFFFFF">
  497. <FORM ACTION="<dtml-var action>" METHOD="GET" <dtml-if
  498.  target>TARGET="<dtml-var target>"</dtml-if>>
  499. <TABLE BORDER="0" WIDTH="100%%" CELLPADDING="10">
  500. <TR>
  501.   <TD VALIGN="TOP">
  502.   <BR>
  503.   <CENTER><B><FONT SIZE="+6" COLOR="#77003B">!</FONT></B></CENTER>
  504.   </TD>
  505.   <TD VALIGN="TOP">
  506.   <BR><BR>
  507.   <CENTER>
  508.   <dtml-var message>
  509.   </CENTER>
  510.   </TD>
  511. </TR>
  512. <TR>
  513.   <TD VALIGN="TOP">
  514.   </TD>
  515.   <TD VALIGN="TOP">
  516.   <CENTER>
  517.   <INPUT TYPE="SUBMIT" VALUE="   Ok   ">
  518.   </CENTER>
  519.   </TD>
  520. </TR>
  521. </TABLE>
  522. </FORM>
  523. </BODY></HTML>""", target='', action='manage_main', title='Changed')
  524.  
  525.  
  526. eNoData=MessageDialog(
  527.         title='No Data',
  528.         message='No clipboard data found.',
  529.         action ='manage_main',)
  530.  
  531. eInvalid=MessageDialog(
  532.          title='Clipboard Error',
  533.          message='The data in the clipboard could not be read, possibly due ' \
  534.          'to cookie data being truncated by your web browser. Try copying ' \
  535.          'fewer objects.',
  536.          action ='manage_main',)
  537.  
  538. eNotFound=MessageDialog(
  539.           title='Item Not Found',
  540.           message='One or more items referred to in the clipboard data was ' \
  541.           'not found. The item may have been moved or deleted after you ' \
  542.           'copied it.',
  543.           action ='manage_main',)
  544.  
  545. eNotSupported=fMessageDialog(
  546.               title='Not Supported',
  547.               message='The item <EM>%s</EM> does not support this operation.',
  548.               action ='manage_main',)
  549.